SureTax Returns API

GET Form Instance Download URL

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint provides clients with the download URL for accessing a specific form instance. A unique URL is generated for restricted access. The URL includes necessary authentication data, ensuring secure access to the form instance and contains expiration time to enhance security.

OperationId: GET Form Instance Download URL

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstanceDownloadURL

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

FormInstanceDownloadURLResponse

OVERVIEWEXAMPLE

Overview

FormInstanceDownloadURLResponse

Display Name	Field Name	Field Type
Data	data	FormInstanceDownloadData

FormInstanceDownloadData

Display Name	Field Name	Field Type
Form Instances	formInstances	array[FormInstanceDownload]

FormInstanceDownload

Display Name	Field Name	Field Type
Id	id	string
Download Url	downloadUrl	string

Example Response

{
  "data": {
    "formInstances": [
      {
        "id": "68962b44-579b-4477-82e5-4b92ae30ce31",
        "downloadUrl": "https://sandboxsuretaxzar.taxrating.net/downloads/7330d7b3-ae00-4c9c-b332-5564280dcb09/TX_01-114_%24webSales_Mar_2024_20240312184655.pdf?sv=2021-10-04\u0026se=2024-06-03T16%3A57%3A07Z\u0026sr=b\u0026sp=r\u0026rscc=max-age%3D0\u0026sig=Rz5lUabVrGgvdJrjj7OG1RTAHALC6SW%2B3IMAyzKf38k%3D"
      }
    ]
  }
}

Response Codes

code	description
200	The API response contains a list of form instances with their download URLs.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. Invalid data provided.
401	Unauthorized access.
500	Internal server error.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstanceDownloadURL

Add Request Headers: